SftTree/OCX 7.0

SftTree.GetHeaderPos Method

Softel vdm, Inc.

Returns the coordinates of a column header.

Deprecated - Provided for compatibility with earlier versions only - Use Header.GetPosition or Headers.GetPosition instead

Syntax       

VB.NET

Boolean = object.GetHeaderPos(ByVal ColIndex As Short, ByRef Left As Single, ByRef Top As Single, ByRef Width As Single, ByRef Height As Single, ByRef Span As Short)  As Boolean

VB

Boolean = object.GetHeaderPos(ByVal ColIndex As Integer, Left As Single, Top As Single, Width As Single, Height As Single, Span As Integer)  As Boolean

C#.NET

bool Boolean = object.GetHeaderPos(short ColIndex, out float Left, out float Top, out float Width, out float Height, out short Span);

VC++

VARIANT_BOOL Boolean = object->GetHeaderPos(short ColIndex, float* Left, float* Top, float* Width, float* Height, short* Span);

C

HRESULT object->raw_GetHeaderPos(short ColIndex, float* Left, float* Top, float* Width, float* Height, short* Span, VARIANT_BOOL* Boolean);

Delphi

Boolean := object.GetHeaderPos(ColIndex : Smallint; out Left : Single; out Top : Single; out Width : Single; out Height : Single; out Span : Smallint)   : WordBool;

object

A SftTree object.

ColIndex

The zero-based column number.  If -1 is specified, the dimensions of the combined row/column header and all column headers are returned.

Left

Returns the horizontal position relative to the top, left corner of the tree control.  The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.

Top

Returns the vertical position relative to the top, left corner of the tree control.  The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.

Width

Returns the width of the column header.  The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.

Height

Returns the height of the column header.  The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.

Span

Returns the number of columns that the column header occupies.  If cell merging is allowed and the column header merges into an adjacent column header, a column header can span more than one column.

Boolean

Boolean

Description

True

The column header specified by ColIndex is displayed and visible.

False

The column header specified by ColIndex is not visible.  The returned coordinates are not valid.

Comments

Deprecated - Provided for compatibility with earlier versions only - Use Header.GetPosition or Headers.GetPosition instead

The GetHeaderPos method returns the coordinates of a column header.

The GetHeaderPos and GetHeaderPosPix methods are synonyms, but may use different coordinate systems.

To retrieve the coordinates of all combined column headers, use Headers.GetPosition instead.

See Also  SftTree Object | Object Hierarchy


Feedback / comments / error reports for this topic
© 2015 - Softel vdm, Inc. - www.softelvdm.com